Viết tài liệu Mẫu_thiết_kế_phần_mềm

Việc viết tài liệu cho một mẫu thiết kế nên chứa đựng đủ thông tin về vấn đề mà mẫu đề cập, ngữ cảnh trong đó nó được sử dụng và giải pháp được đề nghị. Tuy vậy, các tác giả mẫu thường sử dụng các dạng trình bày mẫu riêng của mình để trình bày các mẫu thiết kế, và các dạng trình bày mẫu thường tương tự với các phần cần thiết đã nêu. Các tác giả thường bao gồm thêm một số đoạn để cung cấp nhiều thông tin hơn và tổ chức các phần cần thiết trong những đoạn khác nhau có thể có với những tên khác nhau.Một dạng chung thường được sử dụng là dạng được sử dụng bởi "Bộ tứ" (Các tác giả của Mẫu Thiết Kế). Nó bao gồm các đoạn:

  • Tên mẫu và sự phân loại: Mỗi mẫu nên có một tên mô tả và là duy nhất để danh định và tham khảo đến. Thêm vào đó, một mẫu nên được phân loại theo một cách đã được mô tả trước đó. Việc phân loại giúp việc định ra việc sử dụng mẫu.
  • Dự định: Đoạn này nên mô tả mục tiêu của mẫu và các lập luận cho việc sử dụng mẫu. Nó như phần vấn đề của mẫu.
  • Tên gọi khác: Một mẫu có thể có nhiều hơn một tên. Những tên này nên được viết trong đọan này.
  • Động cơ: Đoạn này cung cấp một kịch bản bao gồm một vấn đề và một ngữ cảnh trong đó mẫu có thể được sử dụng. Với mối quan hệ vấn đề và ngữ cảnh, đoạn này chỉ ra khi nào mẫu được sử dụng.
  • Có thể áp dụng: Đoạn này mô tả các tình huống trong đó mẫu có thể áp dụng. Nó biểu diễn phần ngữ cảnh của mẫu.
  • Cấu trúc: Một biểu diễn đồ thị của mẫu.Sơ đồ lớpSơ đồ tương tác có thể được sử dụng cho cho mục đích này.
  • Thành phần tham gia: Danh sách các lớp và đối tượng được sử dụng trong mẫu này và vai trò của chúng trong thiết kế.
  • Sự cộng tác: Mô tả cách các lớp và các đối tượng được sử dụng trong mẫu tương tác với các đối tượng khác.
  • Các kết quả: Đoạn này mô tả các kết quả, ảnh hưởng và các thỏa hiệp gây ra khi sử dụng mẫu.
  • Sự hiện thực: Đoạn này mô tả sự hiện thực mẫu và biểu diễn phần giải pháp của mẫu. Nó cung cấp các kỹ thuật được sử dụng trong việc hiện thực mẫu, và đề nghị các cách cho sự hiện thực này.
  • Mã mẫu: Một minh họa cách mẫu này được sử dụng trong một ngôn ngữ lập trình.
  • Các sử dụng được biết: Đoạn này bao gồm các ví dụ sử dụng thực sự của mẫu.
  • Các mẫu liên quan: Đoạn này bao gồm các mẫu khác có một số quan hệ với mẫu ví thế chúng có thể được sử dụng cùng với mẫu hoặc thay thế cho mẫu. Nó cũng bao gồm các sự khác nhau của mẫu với các mẫu tương tự khác.

Liên quan

Tài liệu tham khảo

WikiPedia: Mẫu_thiết_kế_phần_mềm http://c2.com/cgi-bin/wiki?HistoryOfPatterns http://c2.com/cgi/wiki?CategoryPattern http://c2.com/doc/oopsla87.html http://www.fluffycat.com/java/patterns.html http://msdn.microsoft.com/practices/compcat/defaul... http://www.mindspring.com/~mgrand/pattern_synopses... http://java.sun.com/blueprints/corej2eepatterns/Pa... http://www.techbookreport.com/SoftwareIndex.html http://hillside.net/patterns/onlinepatterncatalog.... http://patternshare.org/